/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.core.api.config;

import java.util.Collection;

/**
 * Identifies a list of configuration property prototypes that a plugin supports. Each prototype defines if it is an
 * optional or mandatory property that must be defined at run-time.
 * <p/>
 * This list never contains the actual run-time property values; it is only representative of what properties may (or
 * must) be defined in order for the plugin to function correctly.
 *
 * @author Tacoma Four
 */
public interface IConfigurationDescriptor
{
    /**
     * Collection of configuration properties supported by the implementation.
     *
     * @return Collection of configuration property prototypes
     */
    Collection<IConfigPropertyPrototype> supportedProperties();
}
